Function Reference

FileRead

Read in a number of characters from a previously opened text file.

FileRead ( filehandle or "filename" [, count] )

Parameters

filehandle	The handle of a file, as returned by a previous call to FileOpen. Alternatively you may use a string filename as the first parameter.
count	[optional] The number of characters to read. Default read the entire file.

Return Value

Success:	Returns the binary/string read.
Special:	Sets @error to -1 if end-of-file is reached.
Failure:	Sets @error to 1 if file not opened in read mode or other error.

Remarks

If a filename is given rather than a file handle - the file will be opened and closed during the function call - for parsing large text files this will be much slower than using filehandles.
Note: Do not mix filehandles and filenames, i.e., don't FileOpen a file and then use a filename in this function. Use either filehandles or filenames in your routines, not both!

If the file was opened in Raw mode=4, the count must be a multiple of the sector size (512).

If binary data are received they can be converted in hexadecimal string with the String function.

Example

$file = FileOpen("test.txt", 0)

; Check if file opened for reading OK
If $file = -1 Then
MsgBox(0, "Error", "Unable to open file.")
Exit
EndIf

; Read in 1 character at a time until the EOF is reached
While 1
$chars = FileRead($file, 1)
If @error = -1 Then ExitLoop
MsgBox(0, "Char read:", $chars)
Wend

FileClose($file)